﻿// Copyright 2009 Mike Geise
// 
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// 
//     http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

namespace Falcon.Forums.Domain.Services
{
	using System.Collections.Generic;
	using Falcon.Core.Collections;

	public interface IForumTopicSubscriptionService
	{
		/// <summary>
		/// Gets the forum topic subscription by id.
		/// </summary>
		/// <param name="id">The id.</param>
		/// <returns></returns>
		ForumTopicSubscription GetById(int id);

		/// <summary>
		/// Gets the forum topic subscription by the specified specification.
		/// </summary>
		/// <param name="specification">The specification.</param>
		/// <returns></returns>
		ForumTopicSubscription GetBy(ForumTopicSubscriptionSpecification specification);

		/// <summary>
		/// Gets all the forum topic subscriptions using the specified specification.
		/// </summary>
		/// <param name="specification">The specification.</param>
		/// <returns></returns>
		IList<ForumTopicSubscription> GetAll(ForumTopicSubscriptionSpecification specification);

		/// <summary>
		/// Gets all the forum topic subscriptions using the specified specification.
		/// </summary>
		/// <param name="specification">The specification.</param>
		/// <returns></returns>
		IPagedList<ForumTopicSubscription, ForumTopicSubscriptionSpecification> GetPaged(ForumTopicSubscriptionSpecification specification);

		/// <summary>
		/// Creates the forum topic subscription.
		/// </summary>
		/// <returns></returns>
		ForumTopicSubscription Create();

		/// <summary>
		/// Inserts the specified forum topic subscription.
		/// </summary>
		/// <param name="subscription">The subscription.</param>
		void Insert(ForumTopicSubscription subscription);

		/// <summary>
		/// Updates the specified forum topic subscription.
		/// </summary>
		/// <param name="subscription">The subscription.</param>
		void Update(ForumTopicSubscription subscription);

		/// <summary>
		/// Deletes the specified forum topic subscription.
		/// </summary>
		/// <param name="subscription">The subscription.</param>
		void Delete(ForumTopicSubscription subscription);

		/// <summary>
		/// Notifies the subscribers.
		/// </summary>
		/// <param name="specification">The specification.</param>
		void NotifySubscribers(ForumTopicSubscriptionSpecification specification);
	}
}